Chat Thread - Update Chat Thread Properties

Referência

Serviço:: Communication

Versão da API:: 2024-03-15-preview

Atualizações as propriedades de um thread.

PATCH {endpoint}/chat/threads/{chatThreadId}?api-version=2024-03-15-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
chatThreadId	path	True	string	A ID do thread a ser atualizado.
endpoint	path	True	string	O ponto de extremidade do recurso de Comunicação do Azure.
api-version	query	True	string	Versão da API a ser invocada.

Cabeçalho da solicitação

Media Types: "application/merge-patch+json"

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Corpo da solicitação

Media Types: "application/merge-patch+json"

Nome	Tipo	Description
metadata	object	Metadados contextuais para o thread. Os metadados consistem em pares nome-valor. O tamanho total de todos os pares de metadados pode ter até 1 KB de tamanho.
retentionPolicy	ChatRetentionPolicy: ThreadCreationDateRetentionPolicy NoneRetentionPolicy	Política de retenção de dados para exclusão automática.
topic	string	Tópico da conversa de chat.

Respostas

Nome	Tipo	Description
204 No Content		O thread foi atualizado com êxito.
401 Unauthorized	CommunicationErrorResponse	Não autorizado.
403 Forbidden	CommunicationErrorResponse	Negado.
429 Too Many Requests	CommunicationErrorResponse	Solicitações demais.
Other Status Codes	CommunicationErrorResponse	Serviço indisponível.

Segurança

Authorization

Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Tipo: apiKey
Em: header

Exemplos

Update chat thread topic

Solicitação de exemplo

HTTP

PATCH https://contoso.westus.communications.azure.com/chat/threads/19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2?api-version=2024-03-15-preview

{
  "topic": "Updated Thread Topic"
}

Resposta de exemplo

Código de status:: 204

Código de status:: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}

Código de status:: 403

{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}

Código de status:: 429

{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}

Código de status:: 503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definições

Nome	Description
NoneRetentionPolicy	Nenhuma política de retenção de thread.
ThreadCreationDateRetentionPolicy	Política de retenção de thread com base na data de criação do thread.
UpdateChatThreadRequest	Solicitar conteúdo para atualizar uma conversa de chat.

NoneRetentionPolicy

Nenhuma política de retenção de thread.

Nome	Tipo	Description
kind	string: none	Tipo de Política de Retenção

ThreadCreationDateRetentionPolicy

Política de retenção de thread com base na data de criação do thread.

Nome	Tipo	Description
deleteThreadAfterDays	integer	Indica quantos dias após a criação do thread o thread será excluído.
kind	string: threadCreationDate	Tipo de Política de Retenção

UpdateChatThreadRequest

Solicitar conteúdo para atualizar uma conversa de chat.

Nome	Tipo	Description
metadata	object	Metadados contextuais para o thread. Os metadados consistem em pares nome-valor. O tamanho total de todos os pares de metadados pode ter até 1 KB de tamanho.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Política de retenção de dados para exclusão automática.
topic	string	Tópico da conversa de chat.

Compartilhar via