conversations

Creates, updates, deletes, gets or lists a conversations resource.

Overview

Name	conversations
Type	Resource
Id	azure.ai_discovery.conversations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The conversation 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)
displayName	string	The title.
investigationName	string	The Name of the associated Investigation.
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 name of the associated Project.

list

Name	Datatype	Description
name	string	The conversation 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)
displayName	string	The title.
investigationName	string	The Name of the associated Investigation.
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 name of the associated Project.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	conversation_name, endpoint		Fetch a Conversation by name.
list	select	endpoint	investigationName, projectName, createdSince	List Conversation resources.
create	insert	endpoint		Creates a Conversation.
update	update	conversation_name, endpoint		Updates a Conversation.
delete	delete	conversation_name, endpoint		Deletes a Conversation.

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
conversation_name	string	The conversation name. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
createdSince	string (date-time)	The oldest creation timestamp to keep. Default value is None.
investigationName	string	The name of the associated Investigation. Default value is None.
projectName	string	The name of the associated Project. Default value is None.

SELECT examples

get

Fetch a Conversation by name.

SELECT
name,
createdAt,
createdBy,
createdByType,
displayName,
investigationName,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
projectName
FROM azure.ai_discovery.conversations
WHERE conversation_name = '{{ conversation_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List Conversation resources.

SELECT
name,
createdAt,
createdBy,
createdByType,
displayName,
investigationName,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
projectName
FROM azure.ai_discovery.conversations
WHERE endpoint = '{{ endpoint }}' -- required
AND investigationName = '{{ investigationName }}'
AND projectName = '{{ projectName }}'
AND createdSince = '{{ createdSince }}'
;

INSERT examples

create

Creates a Conversation.

INSERT INTO azure.ai_discovery.conversations (
endpoint
)
SELECT 
'{{ endpoint }}'
RETURNING
name,
createdAt,
createdBy,
createdByType,
displayName,
investigationName,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
projectName
;

Manifest

# Description fields are for documentation purposes
- name: conversations
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the conversations resource.

UPDATE examples

update

Updates a Conversation.

UPDATE azure.ai_discovery.conversations
SET 
displayName = '{{ displayName }}',
investigationName = '{{ investigationName }}',
projectName = '{{ projectName }}'
WHERE 
conversation_name = '{{ conversation_name }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
name,
createdAt,
createdBy,
createdByType,
displayName,
investigationName,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
projectName;

DELETE examples

delete

Deletes a Conversation.

DELETE FROM azure.ai_discovery.conversations
WHERE conversation_name = '{{ conversation_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;