indexes

Creates, updates, deletes, gets or lists an indexes resource.

Overview

Name	indexes
Type	Resource
Id	azure.ai_evaluation.indexes

Fields

The following fields are returned by SELECT queries:

get_version

Name	Datatype	Description
id	string	Asset ID, a unique identifier for the asset.
name	string	The name of the resource. Required.
description	string	The asset description text.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
type	string	Type of index. Required. Known values are: "AzureSearch", "CosmosDBNoSqlVectorStore", and "ManagedAzureSearch".
version	string	The version of the resource. Required.

list_versions

Name	Datatype	Description
id	string	Asset ID, a unique identifier for the asset.
name	string	The name of the resource. Required.
description	string	The asset description text.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
type	string	Type of index. Required. Known values are: "AzureSearch", "CosmosDBNoSqlVectorStore", and "ManagedAzureSearch".
version	string	The version of the resource. Required.

list_latest

Name	Datatype	Description
id	string	Asset ID, a unique identifier for the asset.
name	string	The name of the resource. Required.
description	string	The asset description text.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
type	string	Type of index. Required. Known values are: "AzureSearch", "CosmosDBNoSqlVectorStore", and "ManagedAzureSearch".
version	string	The version of the resource. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_version	select	name, version, endpoint		Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.
list_versions	select	name, endpoint		List all versions of the given Index.
list_latest	select	endpoint		List the latest version of each Index.
delete_version	exec	name, version, endpoint		Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist.
create_or_update_version	exec	name, version, endpoint, type		Create a new or update an existing Index with the given version id.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
name	string	The name of the resource. Required.
version	string	The specific version id of the Index to create or update. Required.

SELECT examples

get_version

Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.

SELECT
id,
name,
description,
tags,
type,
version
FROM azure.ai_evaluation.indexes
WHERE name = '{{ name }}' -- required
AND version = '{{ version }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_versions

List all versions of the given Index.

SELECT
id,
name,
description,
tags,
type,
version
FROM azure.ai_evaluation.indexes
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_latest

List the latest version of each Index.

SELECT
id,
name,
description,
tags,
type,
version
FROM azure.ai_evaluation.indexes
WHERE endpoint = '{{ endpoint }}' -- required
;

Lifecycle Methods

delete_version

Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist.

EXEC azure.ai_evaluation.indexes.delete_version 
@name='{{ name }}' --required, 
@version='{{ version }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_or_update_version

Create a new or update an existing Index with the given version id.

EXEC azure.ai_evaluation.indexes.create_or_update_version 
@name='{{ name }}' --required, 
@version='{{ version }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"type": "{{ type }}", 
"description": "{{ description }}", 
"tags": "{{ tags }}"
}'
;