id
stringlengths 7
77
| text
stringlengths 0
3.4k
| metadata
dict |
|---|---|---|
astrapy.info.AdminDatabaseInfo.raw_info
|
{
"kind": "attribute",
"name": "raw_info",
"path": "astrapy.info.AdminDatabaseInfo.raw_info",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_info: dict[str, Any] | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionInfo
|
Represents the identifying information for a collection,
including the information about the database the collection belongs to.
|
{
"kind": "class",
"name": "CollectionInfo",
"path": "astrapy.info.CollectionInfo",
"parameters": [
{
"name": "database_info",
"type": "DatabaseInfo",
"description": null,
"default": null,
"value": null
},
{
"name": "keyspace",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "namespace",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "full_name",
"type": "str",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.info.DatabaseInfo"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "database_info",
"type": "DatabaseInfo",
"description": "a DatabaseInfo instance for the underlying database."
},
{
"name": "keyspace",
"type": "str",
"description": "the keyspace where the collection is located."
},
{
"name": "namespace",
"type": "str",
"description": "an alias for 'keyspace'. *DEPRECATED*, removal in 2.0"
},
{
"name": "name",
"type": "str",
"description": "collection name. Unique within a keyspace."
},
{
"name": "full_name",
"type": "str",
"description": "identifier for the collection within the database,\nin the form \"keyspace.collection_name\"."
}
]
}
|
astrapy.info.CollectionInfo.database_info
|
{
"kind": "attribute",
"name": "database_info",
"path": "astrapy.info.CollectionInfo.database_info",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.info.DatabaseInfo"
],
"value": "database_info: DatabaseInfo",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionInfo.keyspace
|
{
"kind": "attribute",
"name": "keyspace",
"path": "astrapy.info.CollectionInfo.keyspace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "keyspace: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionInfo.namespace
|
{
"kind": "attribute",
"name": "namespace",
"path": "astrapy.info.CollectionInfo.namespace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "namespace: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionInfo.name
|
{
"kind": "attribute",
"name": "name",
"path": "astrapy.info.CollectionInfo.name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "name: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionInfo.full_name
|
{
"kind": "attribute",
"name": "full_name",
"path": "astrapy.info.CollectionInfo.full_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "full_name: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionDefaultIDOptions
|
The "defaultId" component of the collection options.
See the Data API specifications for allowed values.
|
{
"kind": "class",
"name": "CollectionDefaultIDOptions",
"path": "astrapy.info.CollectionDefaultIDOptions",
"parameters": [
{
"name": "default_id_type",
"type": "str",
"description": null,
"default": null,
"value": 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": [
{
"name": "default_id_type",
"type": "str",
"description": "string such as `objectId`, `uuid6` and so on."
}
]
}
|
astrapy.info.CollectionDefaultIDOptions.default_id_type
|
{
"kind": "attribute",
"name": "default_id_type",
"path": "astrapy.info.CollectionDefaultIDOptions.default_id_type",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "default_id_type: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionDefaultIDOptions.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.CollectionDefaultIDOptions.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.CollectionDefaultIDOptions.from_dict
|
Create an instance of CollectionDefaultIDOptions from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.CollectionDefaultIDOptions.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "CollectionDefaultIDOptions | None",
"description": null
}
],
"gathered_types": [
"CollectionDefaultIDOptions"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.CollectionVectorServiceOptions
|
The "vector.service" component of the collection options.
See the Data API specifications for allowed values.
|
{
"kind": "class",
"name": "CollectionVectorServiceOptions",
"path": "astrapy.info.CollectionVectorServiceOptions",
"parameters": [
{
"name": "provider",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "model_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "authentication",
"type": "dict[str, Any] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "parameters",
"type": "dict[str, Any] | None",
"description": null,
"default": "None",
"value": 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": [
{
"name": "provider",
"type": "str | None",
"description": "the name of a service provider for embedding calculation."
},
{
"name": "model_name",
"type": "str | None",
"description": "the name of a specific model for use by the service."
},
{
"name": "authentication",
"type": "dict[str, Any] | None",
"description": "a key-value dictionary for the \"authentication\" specification,\nif any, in the vector service options."
},
{
"name": "parameters",
"type": "dict[str, Any] | None",
"description": "a key-value dictionary for the \"parameters\" specification, if any,\nin the vector service options."
}
]
}
|
astrapy.info.CollectionVectorServiceOptions.provider
|
{
"kind": "attribute",
"name": "provider",
"path": "astrapy.info.CollectionVectorServiceOptions.provider",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "provider: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionVectorServiceOptions.model_name
|
{
"kind": "attribute",
"name": "model_name",
"path": "astrapy.info.CollectionVectorServiceOptions.model_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "model_name: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionVectorServiceOptions.authentication
|
{
"kind": "attribute",
"name": "authentication",
"path": "astrapy.info.CollectionVectorServiceOptions.authentication",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "authentication: dict[str, Any] | None = None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionVectorServiceOptions.parameters
|
{
"kind": "attribute",
"name": "parameters",
"path": "astrapy.info.CollectionVectorServiceOptions.parameters",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "parameters: dict[str, Any] | None = None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionVectorServiceOptions.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.CollectionVectorServiceOptions.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.CollectionVectorServiceOptions.from_dict
|
Create an instance of CollectionVectorServiceOptions from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.CollectionVectorServiceOptions.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "CollectionVectorServiceOptions | None",
"description": null
}
],
"gathered_types": [
"astrapy.info.CollectionVectorServiceOptions"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.CollectionVectorOptions
|
The "vector" component of the collection options.
See the Data API specifications for allowed values.
|
{
"kind": "class",
"name": "CollectionVectorOptions",
"path": "astrapy.info.CollectionVectorOptions",
"parameters": [
{
"name": "dimension",
"type": "int | None",
"description": null,
"default": null,
"value": null
},
{
"name": "metric",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "service",
"type": "CollectionVectorServiceOptions | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.info.CollectionVectorServiceOptions"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "dimension",
"type": "int | None",
"description": "an optional positive integer, the dimensionality of the vector space."
},
{
"name": "metric",
"type": "str | None",
"description": "an optional metric among `VectorMetric.DOT_PRODUCT`,\n`VectorMetric.EUCLIDEAN` and `VectorMetric.COSINE`."
},
{
"name": "service",
"type": "CollectionVectorServiceOptions | None",
"description": "an optional CollectionVectorServiceOptions object in case a\nservice is configured for the collection."
}
]
}
|
astrapy.info.CollectionVectorOptions.dimension
|
{
"kind": "attribute",
"name": "dimension",
"path": "astrapy.info.CollectionVectorOptions.dimension",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "dimension: int | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionVectorOptions.metric
|
{
"kind": "attribute",
"name": "metric",
"path": "astrapy.info.CollectionVectorOptions.metric",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "metric: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionVectorOptions.service
|
{
"kind": "attribute",
"name": "service",
"path": "astrapy.info.CollectionVectorOptions.service",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.info.CollectionVectorServiceOptions"
],
"value": "service: CollectionVectorServiceOptions | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionVectorOptions.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.CollectionVectorOptions.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.CollectionVectorOptions.from_dict
|
Create an instance of CollectionVectorOptions from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.CollectionVectorOptions.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "CollectionVectorOptions | None",
"description": null
}
],
"gathered_types": [
"CollectionVectorOptions"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.CollectionOptions
|
A structure expressing the options of a collection.
See the Data API specifications for detailed specification and allowed values.
|
{
"kind": "class",
"name": "CollectionOptions",
"path": "astrapy.info.CollectionOptions",
"parameters": [
{
"name": "vector",
"type": "CollectionVectorOptions | None",
"description": null,
"default": null,
"value": null
},
{
"name": "indexing",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "default_id",
"type": "CollectionDefaultIDOptions | None",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_options",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"CollectionVectorOptions",
"CollectionDefaultIDOptions"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "vector",
"type": "CollectionVectorOptions | None",
"description": "an optional CollectionVectorOptions object."
},
{
"name": "indexing",
"type": "dict[str, Any] | None",
"description": "an optional dictionary with the \"indexing\" collection properties."
},
{
"name": "default_id",
"type": "CollectionDefaultIDOptions | None",
"description": "an optional CollectionDefaultIDOptions object."
},
{
"name": "raw_options",
"type": "dict[str, Any] | None",
"description": "the raw response from the Data API for the collection configuration."
}
]
}
|
astrapy.info.CollectionOptions.vector
|
{
"kind": "attribute",
"name": "vector",
"path": "astrapy.info.CollectionOptions.vector",
"parameters": null,
"returns": null,
"gathered_types": [
"CollectionVectorOptions"
],
"value": "vector: CollectionVectorOptions | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionOptions.indexing
|
{
"kind": "attribute",
"name": "indexing",
"path": "astrapy.info.CollectionOptions.indexing",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "indexing: dict[str, Any] | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionOptions.default_id
|
{
"kind": "attribute",
"name": "default_id",
"path": "astrapy.info.CollectionOptions.default_id",
"parameters": null,
"returns": null,
"gathered_types": [
"CollectionDefaultIDOptions"
],
"value": "default_id: CollectionDefaultIDOptions | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionOptions.raw_options
|
{
"kind": "attribute",
"name": "raw_options",
"path": "astrapy.info.CollectionOptions.raw_options",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_options: dict[str, Any] | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionOptions.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.CollectionOptions.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.CollectionOptions.flatten
|
Recast this object as a flat key-value pair suitable for
use as kwargs in a create_collection method call (including recasts).
|
{
"kind": "function",
"name": "flatten",
"path": "astrapy.info.CollectionOptions.flatten",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.CollectionOptions.from_dict
|
Create an instance of CollectionOptions from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.CollectionOptions.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "CollectionOptions",
"description": null
}
],
"gathered_types": [
"astrapy.info.CollectionOptions"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.CollectionDescriptor
|
A structure expressing full description of a collection as the Data API
returns it, i.e. its name and its `options` sub-structure.
|
{
"kind": "class",
"name": "CollectionDescriptor",
"path": "astrapy.info.CollectionDescriptor",
"parameters": [
{
"name": "name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "options",
"type": "CollectionOptions",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_descriptor",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.info.CollectionOptions"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "name",
"type": "str",
"description": "the name of the collection."
},
{
"name": "options",
"type": "CollectionOptions",
"description": "a CollectionOptions instance."
},
{
"name": "raw_descriptor",
"type": "dict[str, Any] | None",
"description": "the raw response from the Data API."
}
]
}
|
astrapy.info.CollectionDescriptor.name
|
{
"kind": "attribute",
"name": "name",
"path": "astrapy.info.CollectionDescriptor.name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "name: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionDescriptor.options
|
{
"kind": "attribute",
"name": "options",
"path": "astrapy.info.CollectionDescriptor.options",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.info.CollectionOptions"
],
"value": "options: CollectionOptions",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionDescriptor.raw_descriptor
|
{
"kind": "attribute",
"name": "raw_descriptor",
"path": "astrapy.info.CollectionDescriptor.raw_descriptor",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_descriptor: dict[str, Any] | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.CollectionDescriptor.as_dict
|
Recast this object into a dictionary.
Empty `options` will not be returned at all.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.CollectionDescriptor.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.CollectionDescriptor.flatten
|
Recast this object as a flat key-value pair suitable for
use as kwargs in a create_collection method call (including recasts).
|
{
"kind": "function",
"name": "flatten",
"path": "astrapy.info.CollectionDescriptor.flatten",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.CollectionDescriptor.from_dict
|
Create an instance of CollectionDescriptor from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.CollectionDescriptor.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "CollectionDescriptor",
"description": null
}
],
"gathered_types": [
"astrapy.info.CollectionDescriptor"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.EmbeddingProviderParameter
|
A representation of a parameter as returned by the 'findEmbeddingProviders'
Data API endpoint.
|
{
"kind": "class",
"name": "EmbeddingProviderParameter",
"path": "astrapy.info.EmbeddingProviderParameter",
"parameters": [
{
"name": "default_value",
"type": "Any",
"description": null,
"default": null,
"value": null
},
{
"name": "display_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "help",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "hint",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "required",
"type": "bool",
"description": null,
"default": null,
"value": null
},
{
"name": "parameter_type",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "validation",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": 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": [
{
"name": "default_value",
"type": "Any",
"description": "the default value for the parameter."
},
{
"name": "help",
"type": "str | None",
"description": "a textual description of the parameter."
},
{
"name": "name",
"type": "str",
"description": "the name to use when passing the parameter for vectorize operations."
},
{
"name": "required",
"type": "bool",
"description": "whether the parameter is required or not."
},
{
"name": "parameter_type",
"type": "str",
"description": "a textual description of the data type for the parameter."
},
{
"name": "validation",
"type": "dict[str, Any]",
"description": "a dictionary describing a parameter-specific validation policy."
}
]
}
|
astrapy.info.EmbeddingProviderParameter.default_value
|
{
"kind": "attribute",
"name": "default_value",
"path": "astrapy.info.EmbeddingProviderParameter.default_value",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "default_value: Any",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderParameter.display_name
|
{
"kind": "attribute",
"name": "display_name",
"path": "astrapy.info.EmbeddingProviderParameter.display_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "display_name: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderParameter.help
|
{
"kind": "attribute",
"name": "help",
"path": "astrapy.info.EmbeddingProviderParameter.help",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "help: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderParameter.hint
|
{
"kind": "attribute",
"name": "hint",
"path": "astrapy.info.EmbeddingProviderParameter.hint",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "hint: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderParameter.name
|
{
"kind": "attribute",
"name": "name",
"path": "astrapy.info.EmbeddingProviderParameter.name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "name: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderParameter.required
|
{
"kind": "attribute",
"name": "required",
"path": "astrapy.info.EmbeddingProviderParameter.required",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "required: bool",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderParameter.parameter_type
|
{
"kind": "attribute",
"name": "parameter_type",
"path": "astrapy.info.EmbeddingProviderParameter.parameter_type",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "parameter_type: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderParameter.validation
|
{
"kind": "attribute",
"name": "validation",
"path": "astrapy.info.EmbeddingProviderParameter.validation",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "validation: 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.info.EmbeddingProviderParameter.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.EmbeddingProviderParameter.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.EmbeddingProviderParameter.from_dict
|
Create an instance of EmbeddingProviderParameter from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.EmbeddingProviderParameter.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "EmbeddingProviderParameter",
"description": null
}
],
"gathered_types": [
"EmbeddingProviderParameter"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.EmbeddingProviderModel
|
A representation of an embedding model as returned by the 'findEmbeddingProviders'
Data API endpoint.
|
{
"kind": "class",
"name": "EmbeddingProviderModel",
"path": "astrapy.info.EmbeddingProviderModel",
"parameters": [
{
"name": "name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "parameters",
"type": "list[EmbeddingProviderParameter]",
"description": null,
"default": null,
"value": null
},
{
"name": "vector_dimension",
"type": "int | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"EmbeddingProviderParameter"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "name",
"type": "str",
"description": "the model name as must be passed when issuing\nvectorize operations to the API."
},
{
"name": "parameters",
"type": "list[EmbeddingProviderParameter]",
"description": "a list of the `EmbeddingProviderParameter` objects the model admits."
},
{
"name": "vector_dimension",
"type": "int | None",
"description": "an integer for the dimensionality of the embedding model.\nif this is None, the dimension can assume multiple values as specified\nby a corresponding parameter listed with the model."
}
]
}
|
astrapy.info.EmbeddingProviderModel.name
|
{
"kind": "attribute",
"name": "name",
"path": "astrapy.info.EmbeddingProviderModel.name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "name: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderModel.parameters
|
{
"kind": "attribute",
"name": "parameters",
"path": "astrapy.info.EmbeddingProviderModel.parameters",
"parameters": null,
"returns": null,
"gathered_types": [
"EmbeddingProviderParameter"
],
"value": "parameters: list[EmbeddingProviderParameter]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderModel.vector_dimension
|
{
"kind": "attribute",
"name": "vector_dimension",
"path": "astrapy.info.EmbeddingProviderModel.vector_dimension",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vector_dimension: int | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderModel.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.EmbeddingProviderModel.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.EmbeddingProviderModel.from_dict
|
Create an instance of EmbeddingProviderModel from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.EmbeddingProviderModel.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "EmbeddingProviderModel",
"description": null
}
],
"gathered_types": [
"EmbeddingProviderModel"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.EmbeddingProviderToken
|
A representation of a "token", that is a specific secret string, needed by
an embedding model; this models a part of the response from the
'findEmbeddingProviders' Data API endpoint.
|
{
"kind": "class",
"name": "EmbeddingProviderToken",
"path": "astrapy.info.EmbeddingProviderToken",
"parameters": [
{
"name": "accepted",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "forwarded",
"type": "str",
"description": null,
"default": null,
"value": 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": [
{
"name": "accepted",
"type": "str",
"description": "the name of this \"token\" as seen by the Data API. This is the\nname that should be used in the clients when supplying the secret,\nwhether as header or by shared-secret."
},
{
"name": "forwarded",
"type": "str",
"description": "the name used by the API when issuing the embedding request\nto the embedding provider. This is of no direct interest for the Data API user."
}
]
}
|
astrapy.info.EmbeddingProviderToken.accepted
|
{
"kind": "attribute",
"name": "accepted",
"path": "astrapy.info.EmbeddingProviderToken.accepted",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "accepted: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderToken.forwarded
|
{
"kind": "attribute",
"name": "forwarded",
"path": "astrapy.info.EmbeddingProviderToken.forwarded",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "forwarded: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderToken.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.EmbeddingProviderToken.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.EmbeddingProviderToken.from_dict
|
Create an instance of EmbeddingProviderToken from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.EmbeddingProviderToken.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "EmbeddingProviderToken",
"description": null
}
],
"gathered_types": [
"EmbeddingProviderToken"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.EmbeddingProviderAuthentication
|
A representation of an authentication mode for using an embedding model,
modeling the corresponding part of the response returned by the
'findEmbeddingProviders' Data API endpoint (namely "supportedAuthentication").
|
{
"kind": "class",
"name": "EmbeddingProviderAuthentication",
"path": "astrapy.info.EmbeddingProviderAuthentication",
"parameters": [
{
"name": "enabled",
"type": "bool",
"description": null,
"default": null,
"value": null
},
{
"name": "tokens",
"type": "list[EmbeddingProviderToken]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"EmbeddingProviderToken"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "enabled",
"type": "bool",
"description": "whether this authentication mode is available for a given model."
},
{
"name": "tokens",
"type": "list[EmbeddingProviderToken]",
"description": "a list of `EmbeddingProviderToken` objects,\ndetailing the secrets required for the authentication mode."
}
]
}
|
astrapy.info.EmbeddingProviderAuthentication.enabled
|
{
"kind": "attribute",
"name": "enabled",
"path": "astrapy.info.EmbeddingProviderAuthentication.enabled",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "enabled: bool",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderAuthentication.tokens
|
{
"kind": "attribute",
"name": "tokens",
"path": "astrapy.info.EmbeddingProviderAuthentication.tokens",
"parameters": null,
"returns": null,
"gathered_types": [
"EmbeddingProviderToken"
],
"value": "tokens: list[EmbeddingProviderToken]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProviderAuthentication.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.EmbeddingProviderAuthentication.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.EmbeddingProviderAuthentication.from_dict
|
Create an instance of EmbeddingProviderAuthentication from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.EmbeddingProviderAuthentication.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "EmbeddingProviderAuthentication",
"description": null
}
],
"gathered_types": [
"EmbeddingProviderAuthentication"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.EmbeddingProvider
|
A representation of an embedding provider, as returned by the 'findEmbeddingProviders'
Data API endpoint.
|
{
"kind": "class",
"name": "EmbeddingProvider",
"path": "astrapy.info.EmbeddingProvider",
"parameters": [
{
"name": "display_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "models",
"type": "list[EmbeddingProviderModel]",
"description": null,
"default": null,
"value": null
},
{
"name": "parameters",
"type": "list[EmbeddingProviderParameter]",
"description": null,
"default": null,
"value": null
},
{
"name": "supported_authentication",
"type": "dict[str, EmbeddingProviderAuthentication]",
"description": null,
"default": null,
"value": null
},
{
"name": "url",
"type": "str | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"EmbeddingProviderAuthentication",
"EmbeddingProviderModel",
"EmbeddingProviderParameter"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "display_name",
"type": "str | None",
"description": "a version of the provider name for display and pretty printing.\nNot to be used when issuing vectorize API requests (for the latter, it is\nthe key in the providers dictionary that is required)."
},
{
"name": "models",
"type": "list[EmbeddingProviderModel]",
"description": "a list of `EmbeddingProviderModel` objects pertaining to the provider."
},
{
"name": "parameters",
"type": "list[EmbeddingProviderParameter]",
"description": "a list of `EmbeddingProviderParameter` objects common to all models\nfor this provider."
},
{
"name": "supported_authentication",
"type": "dict[str, EmbeddingProviderAuthentication]",
"description": "a dictionary of the authentication modes for\nthis provider. Note that disabled modes may still appear in this map,\nalbeit with the `enabled` property set to False."
},
{
"name": "url",
"type": "str | None",
"description": "a string template for the URL used by the Data API when issuing the request\ntoward the embedding provider. This is of no direct concern to the Data API user."
}
]
}
|
astrapy.info.EmbeddingProvider.display_name
|
{
"kind": "attribute",
"name": "display_name",
"path": "astrapy.info.EmbeddingProvider.display_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "display_name: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProvider.models
|
{
"kind": "attribute",
"name": "models",
"path": "astrapy.info.EmbeddingProvider.models",
"parameters": null,
"returns": null,
"gathered_types": [
"EmbeddingProviderModel"
],
"value": "models: list[EmbeddingProviderModel]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProvider.parameters
|
{
"kind": "attribute",
"name": "parameters",
"path": "astrapy.info.EmbeddingProvider.parameters",
"parameters": null,
"returns": null,
"gathered_types": [
"EmbeddingProviderParameter"
],
"value": "parameters: list[EmbeddingProviderParameter]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProvider.supported_authentication
|
{
"kind": "attribute",
"name": "supported_authentication",
"path": "astrapy.info.EmbeddingProvider.supported_authentication",
"parameters": null,
"returns": null,
"gathered_types": [
"EmbeddingProviderAuthentication"
],
"value": "supported_authentication: dict[str, EmbeddingProviderAuthentication]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProvider.url
|
{
"kind": "attribute",
"name": "url",
"path": "astrapy.info.EmbeddingProvider.url",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "url: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.EmbeddingProvider.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.EmbeddingProvider.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.EmbeddingProvider.from_dict
|
Create an instance of EmbeddingProvider from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.EmbeddingProvider.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "EmbeddingProvider",
"description": null
}
],
"gathered_types": [
"EmbeddingProvider"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.info.FindEmbeddingProvidersResult
|
A representation of the whole response from the 'findEmbeddingProviders'
Data API endpoint.
|
{
"kind": "class",
"name": "FindEmbeddingProvidersResult",
"path": "astrapy.info.FindEmbeddingProvidersResult",
"parameters": [
{
"name": "embedding_providers",
"type": "dict[str, EmbeddingProvider]",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_info",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"EmbeddingProvider"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "embedding_providers",
"type": "dict[str, EmbeddingProvider]",
"description": "a dictionary of provider names to EmbeddingProvider objects."
},
{
"name": "raw_info",
"type": "dict[str, Any] | None",
"description": "a (nested) dictionary containing the original full response from the endpoint."
}
]
}
|
astrapy.info.FindEmbeddingProvidersResult.embedding_providers
|
{
"kind": "attribute",
"name": "embedding_providers",
"path": "astrapy.info.FindEmbeddingProvidersResult.embedding_providers",
"parameters": null,
"returns": null,
"gathered_types": [
"EmbeddingProvider"
],
"value": "embedding_providers: dict[str, EmbeddingProvider]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.FindEmbeddingProvidersResult.raw_info
|
{
"kind": "attribute",
"name": "raw_info",
"path": "astrapy.info.FindEmbeddingProvidersResult.raw_info",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_info: dict[str, Any] | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.FindEmbeddingProvidersResult.as_dict
|
Recast this object into a dictionary.
|
{
"kind": "function",
"name": "as_dict",
"path": "astrapy.info.FindEmbeddingProvidersResult.as_dict",
"parameters": null,
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"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.info.FindEmbeddingProvidersResult.from_dict
|
Create an instance of FindEmbeddingProvidersResult from a dictionary
such as one from the Data API.
|
{
"kind": "function",
"name": "from_dict",
"path": "astrapy.info.FindEmbeddingProvidersResult.from_dict",
"parameters": [
{
"name": "raw_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "FindEmbeddingProvidersResult",
"description": null
}
],
"gathered_types": [
"astrapy.info.FindEmbeddingProvidersResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.request_tools
|
{
"kind": "module",
"name": "request_tools",
"path": "astrapy.request_tools",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": "logging",
"Any": "typing.Any",
"cast": null,
"httpx": "httpx",
"API_RESPONSE": null,
"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": null,
"List": null,
"Protocol": null,
"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": "astrapy.defaults.DEFAULT_REQUEST_TIMEOUT_MS",
"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.request_tools.logger
|
{
"kind": "attribute",
"name": "logger",
"path": "astrapy.request_tools.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.request_tools.log_httpx_request
|
Log the details of an HTTP request for debugging purposes.
|
{
"kind": "function",
"name": "log_httpx_request",
"path": "astrapy.request_tools.log_httpx_request",
"parameters": [
{
"name": "http_method",
"type": "str",
"description": "the HTTP verb of the request (e.g. \"POST\").",
"default": null,
"value": null
},
{
"name": "full_url",
"type": "str",
"description": "the URL of the request (e.g. \"https://domain.com/full/path\").",
"default": null,
"value": null
},
{
"name": "request_params",
"type": "dict[str, Any] | None",
"description": "parameters of the request.",
"default": null,
"value": null
},
{
"name": "redacted_request_headers",
"type": "dict[str, str]",
"description": "caution, as these will be logged as they are.",
"default": null,
"value": null
},
{
"name": "payload",
"type": "dict[str, Any] | None",
"description": "The 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.request_tools.log_httpx_response
|
Log the details of an httpx.Response.
|
{
"kind": "function",
"name": "log_httpx_response",
"path": "astrapy.request_tools.log_httpx_response",
"parameters": [
{
"name": "response",
"type": "httpx.Response",
"description": "the httpx.Response object to log.",
"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.request_tools.HttpMethod
|
{
"kind": "class",
"name": "HttpMethod",
"path": "astrapy.request_tools.HttpMethod",
"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.request_tools.HttpMethod.GET
|
{
"kind": "attribute",
"name": "GET",
"path": "astrapy.request_tools.HttpMethod.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.request_tools.HttpMethod.POST
|
{
"kind": "attribute",
"name": "POST",
"path": "astrapy.request_tools.HttpMethod.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.request_tools.HttpMethod.PUT
|
{
"kind": "attribute",
"name": "PUT",
"path": "astrapy.request_tools.HttpMethod.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.request_tools.HttpMethod.PATCH
|
{
"kind": "attribute",
"name": "PATCH",
"path": "astrapy.request_tools.HttpMethod.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.request_tools.HttpMethod.DELETE
|
{
"kind": "attribute",
"name": "DELETE",
"path": "astrapy.request_tools.HttpMethod.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.request_tools.TimeoutInfo
|
{
"kind": "class",
"name": "TimeoutInfo",
"path": "astrapy.request_tools.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.request_tools.TimeoutInfo.read
|
{
"kind": "attribute",
"name": "read",
"path": "astrapy.request_tools.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.request_tools.TimeoutInfo.write
|
{
"kind": "attribute",
"name": "write",
"path": "astrapy.request_tools.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.request_tools.TimeoutInfo.base
|
{
"kind": "attribute",
"name": "base",
"path": "astrapy.request_tools.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.request_tools.TimeoutInfoWideType
|
{
"kind": "attribute",
"name": "TimeoutInfoWideType",
"path": "astrapy.request_tools.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.request_tools.to_httpx_timeout
|
{
"kind": "function",
"name": "to_httpx_timeout",
"path": "astrapy.request_tools.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.meta
|
{
"kind": "module",
"name": "meta",
"path": "astrapy.meta",
"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": 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": "warnings",
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": "typing.Sequence",
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": "astrapy.constants.CallerType",
"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": "deprecation.DeprecatedWarning",
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": "astrapy.defaults.CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS",
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS",
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT",
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS",
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT",
"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.meta.check_deprecated_vector_ize
|
{
"kind": "function",
"name": "check_deprecated_vector_ize",
"path": "astrapy.meta.check_deprecated_vector_ize",
"parameters": [
{
"name": "vector",
"type": "Any",
"description": null,
"default": null,
"value": null
},
{
"name": "vectors",
"type": "Any",
"description": null,
"default": null,
"value": null
},
{
"name": "vectorize",
"type": "Any",
"description": null,
"default": null,
"value": null
},
{
"name": "kind",
"type": "str",
"description": null,
"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.meta.check_caller_parameters
|
{
"kind": "function",
"name": "check_caller_parameters",
"path": "astrapy.meta.check_caller_parameters",
"parameters": [
{
"name": "callers",
"type": "Sequence[CallerType]",
"description": null,
"default": null,
"value": null
},
{
"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": "Sequence[CallerType]",
"description": null
}
],
"gathered_types": [
"astrapy.constants.CallerType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.meta.check_deprecated_id_region
|
{
"kind": "function",
"name": "check_deprecated_id_region",
"path": "astrapy.meta.check_deprecated_id_region",
"parameters": [
{
"name": "id",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "region",
"type": "str | None",
"description": null,
"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.meta.check_namespace_keyspace
|
{
"kind": "function",
"name": "check_namespace_keyspace",
"path": "astrapy.meta.check_namespace_keyspace",
"parameters": [
{
"name": "keyspace",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "namespace",
"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
}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.