id
stringlengths 7
77
| text
stringlengths 0
3.4k
| metadata
dict |
|---|---|---|
astrapy.core.ops.AstraDBOps.get_role
|
Retrieve details of a specific role within the organization.
|
{
"kind": "function",
"name": "get_role",
"path": "astrapy.core.ops.AstraDBOps.get_role",
"parameters": [
{
"name": "role",
"type": "str",
"description": "The identifier of the role.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The details of the specified role."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.update_role
|
Update the definition of an existing role within the organization.
|
{
"kind": "function",
"name": "update_role",
"path": "astrapy.core.ops.AstraDBOps.update_role",
"parameters": [
{
"name": "role",
"type": "str",
"description": "The identifier of the role to update.",
"default": "''",
"value": "''"
},
{
"name": "role_definition",
"type": "dict",
"description": "The new definition of the role.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after updating the role."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.delete_role
|
Delete a specific role from the organization.
|
{
"kind": "function",
"name": "delete_role",
"path": "astrapy.core.ops.AstraDBOps.delete_role",
"parameters": [
{
"name": "role",
"type": "str",
"description": "The identifier of the role to delete.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after deleting the role."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.invite_user
|
Invite a new user to the organization.
|
{
"kind": "function",
"name": "invite_user",
"path": "astrapy.core.ops.AstraDBOps.invite_user",
"parameters": [
{
"name": "user_definition",
"type": "dict",
"description": "The definition of the user to be invited.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after inviting the user."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_users
|
Retrieve a list of users within the organization.
|
{
"kind": "function",
"name": "get_users",
"path": "astrapy.core.ops.AstraDBOps.get_users",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of users within the organization."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_user
|
Retrieve details of a specific user within the organization.
|
{
"kind": "function",
"name": "get_user",
"path": "astrapy.core.ops.AstraDBOps.get_user",
"parameters": [
{
"name": "user",
"type": "str",
"description": "The identifier of the user.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The details of the specified user."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.remove_user
|
Remove a user from the organization.
|
{
"kind": "function",
"name": "remove_user",
"path": "astrapy.core.ops.AstraDBOps.remove_user",
"parameters": [
{
"name": "user",
"type": "str",
"description": "The identifier of the user to remove.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after removing the user."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.update_user_roles
|
Update the roles assigned to a specific user within the organization.
|
{
"kind": "function",
"name": "update_user_roles",
"path": "astrapy.core.ops.AstraDBOps.update_user_roles",
"parameters": [
{
"name": "user",
"type": "str",
"description": "The identifier of the user.",
"default": "''",
"value": "''"
},
{
"name": "roles",
"type": "list",
"description": "The list of new roles to assign to the user.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after updating the user's roles."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_clients
|
Retrieve a list of client IDs and secrets associated with the organization.
|
{
"kind": "function",
"name": "get_clients",
"path": "astrapy.core.ops.AstraDBOps.get_clients",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of client IDs and their associated secrets."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.create_token
|
Create a new token with specific roles.
|
{
"kind": "function",
"name": "create_token",
"path": "astrapy.core.ops.AstraDBOps.create_token",
"parameters": [
{
"name": "roles",
"type": "dict",
"description": "The roles to associate with the token:\n{\"roles\": [\"<roleId>\"]}",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after creating the token."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.delete_token
|
Delete a specific token.
|
{
"kind": "function",
"name": "delete_token",
"path": "astrapy.core.ops.AstraDBOps.delete_token",
"parameters": [
{
"name": "token",
"type": "str",
"description": "The identifier of the token to delete.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after deleting the token."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_organization
|
Retrieve details of the current organization.
|
{
"kind": "function",
"name": "get_organization",
"path": "astrapy.core.ops.AstraDBOps.get_organization",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The details of the organization."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_access_lists
|
Retrieve a list of access lists for the organization.
|
{
"kind": "function",
"name": "get_access_lists",
"path": "astrapy.core.ops.AstraDBOps.get_access_lists",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of access lists."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_access_list_template
|
Retrieve a template for creating an access list.
|
{
"kind": "function",
"name": "get_access_list_template",
"path": "astrapy.core.ops.AstraDBOps.get_access_list_template",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "An access list template."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.validate_access_list
|
Validate the configuration of the access list.
|
{
"kind": "function",
"name": "validate_access_list",
"path": "astrapy.core.ops.AstraDBOps.validate_access_list",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The validation result of the access list configuration."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_private_links
|
Retrieve a list of private link connections for the organization.
|
{
"kind": "function",
"name": "get_private_links",
"path": "astrapy.core.ops.AstraDBOps.get_private_links",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of private link connections."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_streaming_providers
|
Retrieve a list of streaming service providers.
|
{
"kind": "function",
"name": "get_streaming_providers",
"path": "astrapy.core.ops.AstraDBOps.get_streaming_providers",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of available streaming service providers."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_streaming_tenants
|
Retrieve a list of streaming tenants.
|
{
"kind": "function",
"name": "get_streaming_tenants",
"path": "astrapy.core.ops.AstraDBOps.get_streaming_tenants",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of streaming tenants and their details."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.create_streaming_tenant
|
Create a new streaming tenant.
|
{
"kind": "function",
"name": "create_streaming_tenant",
"path": "astrapy.core.ops.AstraDBOps.create_streaming_tenant",
"parameters": [
{
"name": "tenant",
"type": "dict",
"description": "The configuration details for the new streaming tenant.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after creating the streaming tenant."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.delete_streaming_tenant
|
Delete a specific streaming tenant from a cluster.
|
{
"kind": "function",
"name": "delete_streaming_tenant",
"path": "astrapy.core.ops.AstraDBOps.delete_streaming_tenant",
"parameters": [
{
"name": "tenant",
"type": "str",
"description": "The identifier of the tenant to delete.",
"default": "''",
"value": "''"
},
{
"name": "cluster",
"type": "str",
"description": "The identifier of the cluster from which the tenant is to be deleted.",
"default": "''",
"value": "''"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "None",
"description": "The response from the server after deleting the streaming tenant."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.ops.AstraDBOps.get_streaming_tenant
|
Retrieve information about the limits and usage of a specific streaming tenant.
|
{
"kind": "function",
"name": "get_streaming_tenant",
"path": "astrapy.core.ops.AstraDBOps.get_streaming_tenant",
"parameters": [
{
"name": "tenant",
"type": "str",
"description": "The identifier of the streaming tenant.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "Details of the specified streaming tenant, including limits and current usage."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.core_types
|
{
"kind": "module",
"name": "core_types",
"path": "astrapy.core.core_types",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": "typing.Any",
"cast": null,
"httpx": null,
"API_RESPONSE": null,
"amake_request": null,
"make_request": null,
"TypedDict": null,
"APIRequestError": null,
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": null,
"DEFAULT_DEV_OPS_URL": null,
"TimeoutInfoWideType": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": "typing.Dict",
"List": "typing.List",
"Protocol": "typing.Protocol",
"Union": "typing.Union",
"datetime": null,
"json": null,
"time": null,
"Iterable": null,
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.core_types.API_RESPONSE
|
{
"kind": "attribute",
"name": "API_RESPONSE",
"path": "astrapy.core.core_types.API_RESPONSE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "API_RESPONSE = Dict[str, Any]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.core_types.OPS_API_RESPONSE
|
{
"kind": "attribute",
"name": "OPS_API_RESPONSE",
"path": "astrapy.core.core_types.OPS_API_RESPONSE",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.core.core_types.API_RESPONSE"
],
"value": "OPS_API_RESPONSE = Union[API_RESPONSE, List[Any]]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.core_types.API_DOC
|
{
"kind": "attribute",
"name": "API_DOC",
"path": "astrapy.core.core_types.API_DOC",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "API_DOC = Dict[str, Any]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.core_types.PaginableRequestMethod
|
{
"kind": "class",
"name": "PaginableRequestMethod",
"path": "astrapy.core.core_types.PaginableRequestMethod",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"Protocol"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.core_types.AsyncPaginableRequestMethod
|
{
"kind": "class",
"name": "AsyncPaginableRequestMethod",
"path": "astrapy.core.core_types.AsyncPaginableRequestMethod",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"Protocol"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils
|
{
"kind": "module",
"name": "utils",
"path": "astrapy.core.utils",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": "logging",
"Any": "typing.Any",
"cast": "typing.cast",
"httpx": "httpx",
"API_RESPONSE": "astrapy.core.core_types.API_RESPONSE",
"amake_request": null,
"make_request": null,
"TypedDict": "typing.TypedDict",
"APIRequestError": null,
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": null,
"DEFAULT_DEV_OPS_URL": null,
"TimeoutInfoWideType": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": "typing.Dict",
"List": null,
"Protocol": null,
"Union": "typing.Union",
"datetime": "datetime",
"json": "json",
"time": "time",
"Iterable": "typing.Iterable",
"__version__": "astrapy.__version__",
"DEFAULT_REDACTED_HEADERS": "astrapy.core.defaults.DEFAULT_REDACTED_HEADERS",
"DEFAULT_TIMEOUT": "astrapy.core.defaults.DEFAULT_TIMEOUT",
"UUID": "astrapy.core.ids.UUID",
"ObjectId": "astrapy.core.ids.ObjectId",
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.CustomLogger
|
{
"kind": "class",
"name": "CustomLogger",
"path": "astrapy.core.utils.CustomLogger",
"parameters": null,
"returns": null,
"gathered_types": [
"Logger"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"logging.Logger"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.CustomLogger.trace
|
{
"kind": "function",
"name": "trace",
"path": "astrapy.core.utils.CustomLogger.trace",
"parameters": [
{
"name": "msg",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "args",
"type": "Any",
"description": null,
"default": "()",
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.logger
|
{
"kind": "attribute",
"name": "logger",
"path": "astrapy.core.utils.logger",
"parameters": null,
"returns": null,
"gathered_types": [
"__name__"
],
"value": "logger = logging.getLogger(__name__)",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.http_methods
|
{
"kind": "class",
"name": "http_methods",
"path": "astrapy.core.utils.http_methods",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.http_methods.GET
|
{
"kind": "attribute",
"name": "GET",
"path": "astrapy.core.utils.http_methods.GET",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "GET = 'GET'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.http_methods.POST
|
{
"kind": "attribute",
"name": "POST",
"path": "astrapy.core.utils.http_methods.POST",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "POST = 'POST'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.http_methods.PUT
|
{
"kind": "attribute",
"name": "PUT",
"path": "astrapy.core.utils.http_methods.PUT",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "PUT = 'PUT'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.http_methods.PATCH
|
{
"kind": "attribute",
"name": "PATCH",
"path": "astrapy.core.utils.http_methods.PATCH",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "PATCH = 'PATCH'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.http_methods.DELETE
|
{
"kind": "attribute",
"name": "DELETE",
"path": "astrapy.core.utils.http_methods.DELETE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DELETE = 'DELETE'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.package_name
|
{
"kind": "attribute",
"name": "package_name",
"path": "astrapy.core.utils.package_name",
"parameters": null,
"returns": null,
"gathered_types": [
"__name__"
],
"value": "package_name = __name__.split('.')[0]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.user_agent_astrapy
|
{
"kind": "attribute",
"name": "user_agent_astrapy",
"path": "astrapy.core.utils.user_agent_astrapy",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.__version__"
],
"value": "user_agent_astrapy = f'{package_name}/{__version__}'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.detect_ragstack_user_agent
|
{
"kind": "function",
"name": "detect_ragstack_user_agent",
"path": "astrapy.core.utils.detect_ragstack_user_agent",
"parameters": null,
"returns": [
{
"name": null,
"type": "str | None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.user_agent_rs
|
{
"kind": "attribute",
"name": "user_agent_rs",
"path": "astrapy.core.utils.user_agent_rs",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "user_agent_rs = detect_ragstack_user_agent()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.log_request
|
Log the details of an HTTP request for debugging purposes.
|
{
"kind": "function",
"name": "log_request",
"path": "astrapy.core.utils.log_request",
"parameters": [
{
"name": "json_data",
"type": "dict or None",
"description": "The JSON payload sent with the request, if any.",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.utils.log_response
|
Log the details of an HTTP response for debugging purposes.
|
{
"kind": "function",
"name": "log_response",
"path": "astrapy.core.utils.log_response",
"parameters": [
{
"name": "r",
"type": "requests.Response",
"description": "The response object from the HTTP request.",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": [
"Response"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.utils.user_agent_string
|
{
"kind": "function",
"name": "user_agent_string",
"path": "astrapy.core.utils.user_agent_string",
"parameters": [
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "str | None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.compose_user_agent
|
{
"kind": "function",
"name": "compose_user_agent",
"path": "astrapy.core.utils.compose_user_agent",
"parameters": [
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "str",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.TimeoutInfo
|
{
"kind": "class",
"name": "TimeoutInfo",
"path": "astrapy.core.utils.TimeoutInfo",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"TypedDict"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.TimeoutInfo.read
|
{
"kind": "attribute",
"name": "read",
"path": "astrapy.core.utils.TimeoutInfo.read",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "read: float",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.TimeoutInfo.write
|
{
"kind": "attribute",
"name": "write",
"path": "astrapy.core.utils.TimeoutInfo.write",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "write: float",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.TimeoutInfo.base
|
{
"kind": "attribute",
"name": "base",
"path": "astrapy.core.utils.TimeoutInfo.base",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "base: float",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.TimeoutInfoWideType
|
{
"kind": "attribute",
"name": "TimeoutInfoWideType",
"path": "astrapy.core.utils.TimeoutInfoWideType",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.request_tools.TimeoutInfo"
],
"value": "TimeoutInfoWideType = Union[TimeoutInfo, float, None]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.to_httpx_timeout
|
{
"kind": "function",
"name": "to_httpx_timeout",
"path": "astrapy.core.utils.to_httpx_timeout",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "httpx.Timeout | None",
"description": null
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"Timeout"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.make_request
|
Make an HTTP request to a specified URL.
|
{
"kind": "function",
"name": "make_request",
"path": "astrapy.core.utils.make_request",
"parameters": [
{
"name": "client",
"type": "httpx",
"description": "The httpx client for the request.",
"default": null,
"value": null
},
{
"name": "base_url",
"type": "str",
"description": "The base URL for the request.",
"default": null,
"value": null
},
{
"name": "auth_header",
"type": "str",
"description": "The authentication header key.",
"default": null,
"value": null
},
{
"name": "token",
"type": "str",
"description": "The token used for authentication.",
"default": null,
"value": null
},
{
"name": "method",
"type": "str",
"description": "The HTTP method to use for the request. Default is POST.",
"default": null,
"value": null
},
{
"name": "path",
"type": "str",
"description": "The specific path to append to the base URL.",
"default": null,
"value": null
},
{
"name": "json_data",
"type": "dict",
"description": "JSON payload to be sent with the request.",
"default": null,
"value": null
},
{
"name": "url_params",
"type": "dict",
"description": "URL parameters to be sent with the request.",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "httpx.Response",
"description": "requests.Response: The response from the HTTP request."
}
],
"gathered_types": [
"Client",
"Response",
"Timeout"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.utils.amake_request
|
Make an HTTP request to a specified URL.
|
{
"kind": "function",
"name": "amake_request",
"path": "astrapy.core.utils.amake_request",
"parameters": [
{
"name": "client",
"type": "httpx",
"description": "The httpx client for the request.",
"default": null,
"value": null
},
{
"name": "base_url",
"type": "str",
"description": "The base URL for the request.",
"default": null,
"value": null
},
{
"name": "auth_header",
"type": "str",
"description": "The authentication header key.",
"default": null,
"value": null
},
{
"name": "token",
"type": "str",
"description": "The token used for authentication.",
"default": null,
"value": null
},
{
"name": "method",
"type": "str",
"description": "The HTTP method to use for the request. Default is POST.",
"default": null,
"value": null
},
{
"name": "path",
"type": "str",
"description": "The specific path to append to the base URL.",
"default": null,
"value": null
},
{
"name": "json_data",
"type": "dict",
"description": "JSON payload to be sent with the request.",
"default": null,
"value": null
},
{
"name": "url_params",
"type": "dict",
"description": "URL parameters to be sent with the request.",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "httpx.Response",
"description": "requests.Response: The response from the HTTP request."
}
],
"gathered_types": [
"AsyncClient",
"Response",
"Timeout"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.utils.make_payload
|
Construct a JSON payload for an HTTP request with a specified top-level key.
|
{
"kind": "function",
"name": "make_payload",
"path": "astrapy.core.utils.make_payload",
"parameters": [
{
"name": "top_level",
"type": "str",
"description": "The top-level key for the JSON payload.",
"default": null,
"value": null
},
{
"name": "**kwargs",
"type": "Any",
"description": "Arbitrary keyword arguments representing other keys and their values to be included in the payload.",
"default": "{}",
"value": "{}"
}
],
"returns": [
{
"name": "dict",
"type": "dict[str, Any]",
"description": "The constructed JSON payload."
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.utils.convert_vector_to_floats
|
Convert a vector of strings to a vector of floats.
|
{
"kind": "function",
"name": "convert_vector_to_floats",
"path": "astrapy.core.utils.convert_vector_to_floats",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "A vector of objects.",
"default": null,
"value": null
}
],
"returns": [
{
"name": "list",
"type": "list[float]",
"description": "A vector of floats."
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.utils.is_list_of_floats
|
Safely determine if it's a list of floats.
Assumption: if list, and first item is float, then all items are.
|
{
"kind": "function",
"name": "is_list_of_floats",
"path": "astrapy.core.utils.is_list_of_floats",
"parameters": [
{
"name": "vector",
"type": "Iterable[Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "bool",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.utils.convert_to_ejson_date_object
|
{
"kind": "function",
"name": "convert_to_ejson_date_object",
"path": "astrapy.core.utils.convert_to_ejson_date_object",
"parameters": [
{
"name": "date_value",
"type": "datetime.date | datetime.datetime",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "dict[str, int]",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.convert_to_ejson_uuid_object
|
{
"kind": "function",
"name": "convert_to_ejson_uuid_object",
"path": "astrapy.core.utils.convert_to_ejson_uuid_object",
"parameters": [
{
"name": "uuid_value",
"type": "UUID",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "dict[str, str]",
"description": null
}
],
"gathered_types": [
"UUID"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.convert_to_ejson_objectid_object
|
{
"kind": "function",
"name": "convert_to_ejson_objectid_object",
"path": "astrapy.core.utils.convert_to_ejson_objectid_object",
"parameters": [
{
"name": "objectid_value",
"type": "ObjectId",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "dict[str, str]",
"description": null
}
],
"gathered_types": [
"ObjectId"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.convert_ejson_date_object_to_datetime
|
{
"kind": "function",
"name": "convert_ejson_date_object_to_datetime",
"path": "astrapy.core.utils.convert_ejson_date_object_to_datetime",
"parameters": [
{
"name": "date_object",
"type": "dict[str, int]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "datetime.datetime",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.convert_ejson_uuid_object_to_uuid
|
{
"kind": "function",
"name": "convert_ejson_uuid_object_to_uuid",
"path": "astrapy.core.utils.convert_ejson_uuid_object_to_uuid",
"parameters": [
{
"name": "uuid_object",
"type": "dict[str, str]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "UUID",
"description": null
}
],
"gathered_types": [
"UUID"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.convert_ejson_objectid_object_to_objectid
|
{
"kind": "function",
"name": "convert_ejson_objectid_object_to_objectid",
"path": "astrapy.core.utils.convert_ejson_objectid_object_to_objectid",
"parameters": [
{
"name": "objectid_object",
"type": "dict[str, str]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "ObjectId",
"description": null
}
],
"gathered_types": [
"ObjectId"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.utils.normalize_for_api
|
Normalize a payload for API calls.
This includes e.g. ensuring values for "$vector" key
are made into plain lists of floats.
|
{
"kind": "function",
"name": "normalize_for_api",
"path": "astrapy.core.utils.normalize_for_api",
"parameters": [
{
"name": "payload",
"type": "Dict[str, Any]",
"description": "A dict expressing a payload for an API call",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "dict[str, Any] | None",
"description": "Dict[str, Any]: a \"normalized\" payload dict"
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.utils.restore_from_api
|
Process a dictionary just returned from the API.
This is the place where e.g. `{"$date": 123}` is
converted back into a datetime object.
|
{
"kind": "function",
"name": "restore_from_api",
"path": "astrapy.core.utils.restore_from_api",
"parameters": [
{
"name": "response",
"type": "API_RESPONSE",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "API_RESPONSE",
"description": null
}
],
"gathered_types": [
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.defaults
|
{
"kind": "module",
"name": "defaults",
"path": "astrapy.core.defaults",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": null,
"cast": null,
"httpx": null,
"API_RESPONSE": null,
"amake_request": null,
"make_request": null,
"TypedDict": null,
"APIRequestError": null,
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": null,
"DEFAULT_DEV_OPS_URL": null,
"TimeoutInfoWideType": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": null,
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": null,
"time": null,
"Iterable": null,
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_AUTH_PATH
|
{
"kind": "attribute",
"name": "DEFAULT_AUTH_PATH",
"path": "astrapy.core.defaults.DEFAULT_AUTH_PATH",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_AUTH_PATH = '/api/rest/v1/auth'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_JSON_API_PATH
|
{
"kind": "attribute",
"name": "DEFAULT_JSON_API_PATH",
"path": "astrapy.core.defaults.DEFAULT_JSON_API_PATH",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_JSON_API_PATH = '/api/json'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_JSON_API_VERSION
|
{
"kind": "attribute",
"name": "DEFAULT_JSON_API_VERSION",
"path": "astrapy.core.defaults.DEFAULT_JSON_API_VERSION",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_JSON_API_VERSION = 'v1'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_DEV_OPS_URL
|
{
"kind": "attribute",
"name": "DEFAULT_DEV_OPS_URL",
"path": "astrapy.core.defaults.DEFAULT_DEV_OPS_URL",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_DEV_OPS_URL = 'https://api.astra.datastax.com'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_DEV_OPS_API_VERSION
|
{
"kind": "attribute",
"name": "DEFAULT_DEV_OPS_API_VERSION",
"path": "astrapy.core.defaults.DEFAULT_DEV_OPS_API_VERSION",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_DEV_OPS_API_VERSION = 'v2'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_DEV_OPS_AUTH_HEADER
|
{
"kind": "attribute",
"name": "DEFAULT_DEV_OPS_AUTH_HEADER",
"path": "astrapy.core.defaults.DEFAULT_DEV_OPS_AUTH_HEADER",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_DEV_OPS_AUTH_HEADER = 'Authorization'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_TIMEOUT
|
{
"kind": "attribute",
"name": "DEFAULT_TIMEOUT",
"path": "astrapy.core.defaults.DEFAULT_TIMEOUT",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_TIMEOUT = 30000",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_AUTH_HEADER
|
{
"kind": "attribute",
"name": "DEFAULT_AUTH_HEADER",
"path": "astrapy.core.defaults.DEFAULT_AUTH_HEADER",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_AUTH_HEADER = 'Token'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_KEYSPACE_NAME
|
{
"kind": "attribute",
"name": "DEFAULT_KEYSPACE_NAME",
"path": "astrapy.core.defaults.DEFAULT_KEYSPACE_NAME",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_KEYSPACE_NAME = 'default_keyspace'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_REGION
|
{
"kind": "attribute",
"name": "DEFAULT_REGION",
"path": "astrapy.core.defaults.DEFAULT_REGION",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_REGION = 'us-east1'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_INSERT_NUM_DOCUMENTS
|
{
"kind": "attribute",
"name": "DEFAULT_INSERT_NUM_DOCUMENTS",
"path": "astrapy.core.defaults.DEFAULT_INSERT_NUM_DOCUMENTS",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_INSERT_NUM_DOCUMENTS = 50",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.defaults.DEFAULT_REDACTED_HEADERS
|
{
"kind": "attribute",
"name": "DEFAULT_REDACTED_HEADERS",
"path": "astrapy.core.defaults.DEFAULT_REDACTED_HEADERS",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.core.defaults.DEFAULT_AUTH_HEADER",
"astrapy.core.defaults.DEFAULT_DEV_OPS_AUTH_HEADER"
],
"value": "DEFAULT_REDACTED_HEADERS = {DEFAULT_DEV_OPS_AUTH_HEADER, DEFAULT_AUTH_HEADER, 'X-Embedding-Api-Key', 'X-Embedding-Access-Id', 'X-Embedding-Secret-Id'}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.ids
|
{
"kind": "module",
"name": "ids",
"path": "astrapy.core.ids",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": null,
"cast": null,
"httpx": null,
"API_RESPONSE": null,
"amake_request": null,
"make_request": null,
"TypedDict": null,
"APIRequestError": null,
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": null,
"DEFAULT_DEV_OPS_URL": null,
"TimeoutInfoWideType": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": null,
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": null,
"time": null,
"Iterable": null,
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": "uuid.UUID",
"ObjectId": "bson.objectid.ObjectId",
"uuid1": "uuid.uuid1",
"uuid3": "uuid.uuid3",
"uuid4": "uuid.uuid4",
"uuid5": "uuid.uuid5",
"uuid6": "uuid6.uuid6",
"uuid7": "uuid6.uuid7",
"uuid8": "uuid6.uuid8",
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": [
"ObjectId",
"uuid1",
"uuid3",
"uuid4",
"uuid5",
"uuid6",
"uuid7",
"uuid8",
"UUID"
],
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.db
|
Core "db" subpackage, exported here to preserve import patterns.
|
{
"kind": "module",
"name": "db",
"path": "astrapy.db",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": null,
"cast": null,
"httpx": null,
"API_RESPONSE": null,
"amake_request": null,
"make_request": null,
"TypedDict": null,
"APIRequestError": null,
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": null,
"DEFAULT_DEV_OPS_URL": null,
"TimeoutInfoWideType": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": null,
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": null,
"time": null,
"Iterable": null,
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": "astrapy.core.db.AstraDB",
"AstraDBCollection": "astrapy.core.db.AstraDBCollection",
"AsyncAstraDB": "astrapy.core.db.AsyncAstraDB",
"AsyncAstraDBCollection": "astrapy.core.db.AsyncAstraDBCollection",
"logger": "astrapy.core.db.logger",
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": true,
"is_package": false,
"is_subpackage": true,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": [
"AsyncAstraDBCollection",
"AsyncAstraDB",
"logger",
"AstraDBCollection",
"AstraDB"
],
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.api
|
Core "api" subpackage, exported here to preserve import patterns.
|
{
"kind": "module",
"name": "api",
"path": "astrapy.api",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": null,
"cast": null,
"httpx": null,
"API_RESPONSE": null,
"amake_request": null,
"make_request": null,
"TypedDict": null,
"APIRequestError": "astrapy.core.api.APIRequestError",
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": null,
"DEFAULT_DEV_OPS_URL": null,
"TimeoutInfoWideType": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": null,
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": null,
"time": null,
"Iterable": null,
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": true,
"is_package": false,
"is_subpackage": true,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": [
"APIRequestError"
],
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.ops
|
Core "ops" subpackage, exported here to preserve import patterns.
|
{
"kind": "module",
"name": "ops",
"path": "astrapy.ops",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": null,
"cast": null,
"httpx": null,
"API_RESPONSE": null,
"amake_request": null,
"make_request": null,
"TypedDict": null,
"APIRequestError": null,
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": null,
"DEFAULT_DEV_OPS_URL": null,
"TimeoutInfoWideType": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": null,
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": null,
"time": null,
"Iterable": null,
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": "astrapy.core.ops.AstraDBOps",
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": true,
"is_package": false,
"is_subpackage": true,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": [
"AstraDBOps"
],
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.