Indexes - Get Version
获取索引的特定版本。 如果索引不存在，则服务将返回 404 Not Found 错误。
GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Project 端点。 在格式 “https://your-ai-services-account-name.services.ai.azure.com/api/projects/_project"如果您的 Foundry Hub 只有一个 Project，或者使用 Hub 中的默认 Project。 或以 “https://your-ai-services-account-name.services.ai.azure.com/api/projects/your-project-name"如果要显式指定 Foundry Project 名称。 |
|
name
|
path | True |
string |
资源的名称 |
|
version
|
path | True |
string |
要检索的 Index 的特定版本 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此操作的 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK | Index: |
请求已成功。 |
| Other Status Codes |
意外的错误响应。 标头 x-ms-error-code: string |
安全性
OAuth2Auth
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
作用域
| 名称 | 说明 |
|---|---|
| https://ai.azure.com/.default |
示例
|
Indexes_Get |
|
Indexes_Get |
Indexes_GetVersion_MaximumSet
示例请求
GET {endpoint}/indexes/ascwgkgwpqxeinbp/versions/bqhzitucneeoxurvf?api-version=v1
示例响应
{
"type": "Index",
"id": "xtjevbrwrwuwkbujuwpq",
"name": "wwikvkcdcobt",
"version": "swnonkxmjl"
}Indexes_GetVersion_MinimumSet
示例请求
GET {endpoint}/indexes/sflsamumttlwccuxveocgozlkmdme/versions/txg?api-version=v1
示例响应
{
"type": "Index",
"name": "wwikvkcdcobt",
"version": "swnonkxmjl"
}定义
| 名称 | 说明 |
|---|---|
|
Azure. |
错误对象。 |
|
Azure. |
包含错误详细信息的响应。 |
|
Azure. |
包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。 |
|
Azure |
Azure AI 搜索索引定义 |
|
Cosmos |
CosmosDB 矢量存储索引定义 |
|
Embedding |
嵌入配置类 |
|
Field |
字段映射配置类 |
|
Index |
|
|
Managed |
托管 Azure AI 搜索索引定义 |
Azure.Core.Foundations.Error
错误对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
服务器定义的错误代码集之一。 |
| details |
导致此报告错误的特定错误的详细信息数组。 |
|
| innererror |
包含与当前对象有关错误的更具体信息的对象。 |
|
| message |
string |
有关错误的可读的表示形式。 |
| target |
string |
错误的目标。 |
Azure.Core.Foundations.ErrorResponse
包含错误详细信息的响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
Azure.Core.Foundations.InnerError
包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
服务器定义的错误代码集之一。 |
| innererror |
内部错误。 |
AzureAISearchIndex
Azure AI 搜索索引定义
| 名称 | 类型 | 说明 |
|---|---|---|
| connectionName |
string |
与 Azure AI 搜索的连接名称 |
| description |
string |
资产说明文本。 |
| fieldMapping |
字段映射配置 |
|
| id |
string |
资产 ID，资产的唯一标识符 |
| indexName |
string |
要附加的 Azure AI 搜索资源中的索引名称 |
| name |
string |
资源的名称 |
| tags |
object |
标记字典。 可以添加、删除和更新标记。 |
| type |
string:
Azure |
索引类型 |
| version |
string |
资源的版本 |
CosmosDBIndex
CosmosDB 矢量存储索引定义
| 名称 | 类型 | 说明 |
|---|---|---|
| connectionName |
string |
与 CosmosDB 的连接名称 |
| containerName |
string |
CosmosDB 容器的名称 |
| databaseName |
string |
CosmosDB 数据库的名称 |
| description |
string |
资产说明文本。 |
| embeddingConfiguration |
嵌入模型配置 |
|
| fieldMapping |
字段映射配置 |
|
| id |
string |
资产 ID，资产的唯一标识符 |
| name |
string |
资源的名称 |
| tags |
object |
标记字典。 可以添加、删除和更新标记。 |
| type |
string:
Cosmos |
索引类型 |
| version |
string |
资源的版本 |
EmbeddingConfiguration
嵌入配置类
| 名称 | 类型 | 说明 |
|---|---|---|
| embeddingField |
string |
Embedding 字段 |
| modelDeploymentName |
string |
嵌入模型的部署名称。 它可以指向父 AIServices 或连接中的模型部署。 |
FieldMapping
字段映射配置类
| 名称 | 类型 | 说明 |
|---|---|---|
| contentFields |
string[] |
包含文本内容的字段列表 |
| filepathField |
string |
要用作文本内容源的文件路径 |
| metadataFields |
string[] |
包含元数据内容的字段列表 |
| titleField |
string |
包含文档标题的字段 |
| urlField |
string |
包含文档 URL 的字段 |
| vectorFields |
string[] |
包含向量内容的字段列表 |
IndexType
| 值 | 说明 |
|---|---|
| AzureSearch |
Azure 搜索 |
| CosmosDBNoSqlVectorStore |
科斯莫斯DB |
| ManagedAzureSearch |
托管 Azure 搜索 |
ManagedAzureAISearchIndex
托管 Azure AI 搜索索引定义
| 名称 | 类型 | 说明 |
|---|---|---|
| description |
string |
资产说明文本。 |
| id |
string |
资产 ID，资产的唯一标识符 |
| name |
string |
资源的名称 |
| tags |
object |
标记字典。 可以添加、删除和更新标记。 |
| type |
string:
Managed |
索引类型 |
| vectorStoreId |
string |
托管索引的向量存储 ID |
| version |
string |
资源的版本 |