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":... | |
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",
"descript... |
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": n... | |
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"... | |
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,
"referenc... | |
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,
"n... | |
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,
"referenc... | |
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,
... |
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,
... | |
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,
... |
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,... |
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",
"ty... |
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... | |
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,
"e... | |
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":... | |
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,
"ex... | |
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... |
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": n... |
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"... |
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": n... | |
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,
"r... | |
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,
... | |
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,
"pr... |
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,
... |
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... |
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": nul... | |
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":... | |
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": nu... | |
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,
"... | |
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,
"properti... |
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,
"properti... |
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": "... |
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",
"d... |
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... | |
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": nul... | |
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... | |
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,
"prope... |
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,
"prope... |
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"... |
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": "st... |
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,
"exa... | |
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,
... | |
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,
"refe... | |
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,
"refe... | |
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"... | |
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,
... | |
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,
"... | |
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,
"e... | |
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,
... |
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,
... |
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[EmbeddingProvide... |
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": nu... | |
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"... | |
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": ... | |
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,
"pro... |
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,
"typ... |
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",
"descr... |
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,
"ref... | |
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,
"... | |
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,
"pro... |
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,
"typ... |
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": "lis... |
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,... | |
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,
"... | |
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": nul... |
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,
... |
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[EmbeddingProvid... |
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"... | |
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,
... | |
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": nul... | |
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]",... | |
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": nul... | |
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,
"properti... |
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": "... |
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"... |
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": ... | |
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,
... | |
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,
... |
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,
... |
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,
"... | |
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,
"e... | |
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"... |
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": [
... |
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":... | |
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,... | |
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": n... | |
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,... | |
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... | |
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,
"refere... | |
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,
"reference... | |
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": nu... | |
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":... | |
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": nu... | |
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": ... | |
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,
... | |
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_... | |
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",
... | |
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",
"typ... | |
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 | Non... | |
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 ... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.