investigations

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

Overview

Name	`investigations`
Type	Resource
Id	`azure.ai_discovery.investigations`

Fields

The following fields are returned by SELECT queries:

get_operation_status
get
list

Name	Datatype	Description
`id`	`string`	The unique ID of the operation. Required.
`error`	`object`	Error object that describes the error when status is "Failed".
`result`	`object`	The result of the operation.
`status`	`string`	The status of the operation. Required. Known values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled". (NotStarted, Running, Succeeded, Failed, Canceled)

Name	Datatype	Description
`name`	`string`	The investigation name. Required.
`createdAt`	`string (date-time)`	The timestamp when the resource was created.
`createdBy`	`string`	The ID of the user who created this resource.
`createdByType`	`string`	The type of user who created this resource. Known values are: "User", "Application", and "System". (User, Application, System)
`description`	`string`	The description.
`displayName`	`string`	The title.
`lastModifiedAt`	`string (date-time)`	The timestamp when the resource was last updated.
`lastModifiedBy`	`string`	The ID of the user who updated this resource.
`lastModifiedByType`	`string`	The type of user who updated this resource. Known values are: "User", "Application", and "System". (User, Application, System)
`projectName`	`string`	The parent project name. Required.
`status`	`string`	The status. Known values are: "Created", "Validated", and "Failed". (Created, Validated, Failed)
`tags`	`array`	The tags.

Name	Datatype	Description
`name`	`string`	The investigation name. Required.
`createdAt`	`string (date-time)`	The timestamp when the resource was created.
`createdBy`	`string`	The ID of the user who created this resource.
`createdByType`	`string`	The type of user who created this resource. Known values are: "User", "Application", and "System". (User, Application, System)
`description`	`string`	The description.
`displayName`	`string`	The title.
`lastModifiedAt`	`string (date-time)`	The timestamp when the resource was last updated.
`lastModifiedBy`	`string`	The ID of the user who updated this resource.
`lastModifiedByType`	`string`	The type of user who updated this resource. Known values are: "User", "Application", and "System". (User, Application, System)
`projectName`	`string`	The parent project name. Required.
`status`	`string`	The status. Known values are: "Created", "Validated", and "Failed". (Created, Validated, Failed)
`tags`	`array`	The tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_operation_status`	`select`	`project_name`, `investigation_name`, `operation_id`, `endpoint`		Get the status of a long-running operation.
`get`	`select`	`project_name`, `investigation_name`, `endpoint`		Fetch a Investigation by name.
`list`	`select`	`project_name`, `endpoint`	`createdSince`	List Investigation resources.
`create_or_update`	`insert`	`project_name`, `investigation_name`, `endpoint`		Updates an Investigation.
`create_or_update`	`replace`	`project_name`, `investigation_name`, `endpoint`		Updates an Investigation.
`delete`	`delete`	`project_name`, `investigation_name`, `endpoint`		Delete a Investigation.
`create_or_replace`	`exec`	`project_name`, `investigation_name`, `endpoint`		Creates an Investigation.
`get_discovery_engine`	`exec`	`project_name`, `investigation_name`, `endpoint`		Get the discovery engine for an investigation.
`update_discovery_engine`	`exec`	`project_name`, `investigation_name`, `endpoint`		Update the discovery engine for an investigation. This will create the discovery engine if it does not already exist.
`get_discovery_engine_memory`	`exec`	`project_name`, `investigation_name`, `endpoint`	`skip`, `top`, `maxPageSize`	List discovery engine working memory entries for an investigation.
`start_discovery_engine`	`exec`	`project_name`, `investigation_name`, `endpoint`		Start the discovery engine for an investigation.
`stop_discovery_engine`	`exec`	`project_name`, `investigation_name`, `endpoint`		Stop the discovery engine for an investigation.

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: )
`investigation_name`	`string`	The investigation name. Required.
`operation_id`	`string`	The unique ID of the operation. Required.
`project_name`	`string`	The project name. Required.
`createdSince`	`string (date-time)`	The oldest creation timestamp to keep. Default value is None.
`maxPageSize`	`integer`	Bound the number of results that come back in one response. Default value is None.
`skip`	`integer`	Skip results. Default value is None.
`top`	`integer`	Query the top results. Default value is None.

`SELECT` examples

get_operation_status
get
list

Get the status of a long-running operation.

SELECT
id,
error,
result,
status
FROM azure.ai_discovery.investigations
WHERE project_name = '{{ project_name }}' -- required
AND investigation_name = '{{ investigation_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

Fetch a Investigation by name.

SELECT
name,
createdAt,
createdBy,
createdByType,
description,
displayName,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
projectName,
status,
tags
FROM azure.ai_discovery.investigations
WHERE project_name = '{{ project_name }}' -- required
AND investigation_name = '{{ investigation_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

List Investigation resources.

SELECT
name,
createdAt,
createdBy,
createdByType,
description,
displayName,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
projectName,
status,
tags
FROM azure.ai_discovery.investigations
WHERE project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND createdSince = '{{ createdSince }}'
;

`INSERT` examples

create_or_update
Manifest

Updates an Investigation.

INSERT INTO azure.ai_discovery.investigations (
description,
tags,
displayName,
project_name,
investigation_name,
endpoint
)
SELECT 
'{{ description }}',
'{{ tags }}',
'{{ displayName }}',
'{{ project_name }}',
'{{ investigation_name }}',
'{{ endpoint }}'
RETURNING
name,
createdAt,
createdBy,
createdByType,
description,
displayName,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
projectName,
status,
tags
;

# Description fields are for documentation purposes
- name: investigations
props:
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the investigations resource.
  - name: investigation_name
    value: "{{ investigation_name }}"
    description: Required parameter for the investigations resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the investigations resource.
  - name: description
    value: "{{ description }}"
    description: |
      The description.
  - name: tags
    description: |
      The tags.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The title.

`REPLACE` examples

create_or_update

Updates an Investigation.

REPLACE azure.ai_discovery.investigations
SET 
description = '{{ description }}',
tags = '{{ tags }}',
displayName = '{{ displayName }}'
WHERE 
project_name = '{{ project_name }}' --required
AND investigation_name = '{{ investigation_name }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
name,
createdAt,
createdBy,
createdByType,
description,
displayName,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
projectName,
status,
tags;

`DELETE` examples

delete

Delete a Investigation.

DELETE FROM azure.ai_discovery.investigations
WHERE project_name = '{{ project_name }}' --required
AND investigation_name = '{{ investigation_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

Creates an Investigation.

EXEC azure.ai_discovery.investigations.create_or_replace 
@project_name='{{ project_name }}' --required, 
@investigation_name='{{ investigation_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"description": "{{ description }}", 
"tags": "{{ tags }}", 
"displayName": "{{ displayName }}"
}'
;

Get the discovery engine for an investigation.

EXEC azure.ai_discovery.investigations.get_discovery_engine 
@project_name='{{ project_name }}' --required, 
@investigation_name='{{ investigation_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

Update the discovery engine for an investigation. This will create the discovery engine if it does not already exist.

EXEC azure.ai_discovery.investigations.update_discovery_engine 
@project_name='{{ project_name }}' --required, 
@investigation_name='{{ investigation_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"discoveryEngineStatus": "{{ discoveryEngineStatus }}", 
"systemPrompt": "{{ systemPrompt }}", 
"configuration": "{{ configuration }}"
}'
;

List discovery engine working memory entries for an investigation.

EXEC azure.ai_discovery.investigations.get_discovery_engine_memory 
@project_name='{{ project_name }}' --required, 
@investigation_name='{{ investigation_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}', 
@maxPageSize='{{ maxPageSize }}'
;

Start the discovery engine for an investigation.

EXEC azure.ai_discovery.investigations.start_discovery_engine 
@project_name='{{ project_name }}' --required, 
@investigation_name='{{ investigation_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

Stop the discovery engine for an investigation.

EXEC azure.ai_discovery.investigations.stop_discovery_engine 
@project_name='{{ project_name }}' --required, 
@investigation_name='{{ investigation_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​