Conversation Authoring Project - Create Project

Usługa:

Azure AI Services

Wersja interfejsu API:

2025-11-01

Tworzy nowy projekt lub aktualizuje istniejący.

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?api-version=2025-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string (uri)	Obsługiwany punkt końcowy usług Cognitive Services, np. https://< nazwa-zasobu.api.cognitiveservices.azure.com>.
projectName	path	True	string maxLength: 100	Nowa nazwa projektu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

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

Nazwa	Wymagane	Typ	Opis
language	True	string	Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
projectKind	True	ProjectKind	Reprezentuje rodzaj projektu.
projectName	True	string	Nowa nazwa projektu.
description		string	Opis projektu.
multilingual		boolean	Czy projekt będzie używany w wielu językach, czy nie.
settings		AnalyzeConversationAuthoringProjectSettings	Ustawienia projektu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnalyzeConversationAuthoringProjectMetadata	Żądanie zakończyło się pomyślnie.
201 Created	AnalyzeConversationAuthoringProjectMetadata	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Successful Create Project

Przykładowe żądanie

HTTP

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2025-11-01

{
  "projectName": "myproject",
  "language": "en",
  "projectKind": "Conversation",
  "description": "This is a sample conversation project.",
  "multilingual": false
}

Przykładowa odpowiedź

Kod stanu:

201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Kod stanu:

200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Definicje

Nazwa	Opis
AnalyzeConversationAuthoringCreateProjectOptions	Reprezentuje opcje używane do tworzenia lub aktualizowania projektu.
AnalyzeConversationAuthoringProjectMetadata	Reprezentuje metadane projektu.
AnalyzeConversationAuthoringProjectSettings	Reprezentuje ustawienia używane do definiowania zachowania projektu.
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
ProjectKind

AnalyzeConversationAuthoringCreateProjectOptions

Objekt

Reprezentuje opcje używane do tworzenia lub aktualizowania projektu.

Nazwa	Typ	Opis
description	string	Opis projektu.
language	string	Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
multilingual	boolean	Czy projekt będzie używany w wielu językach, czy nie.
projectKind	ProjectKind	Reprezentuje rodzaj projektu.
projectName	string	Nowa nazwa projektu.
settings	AnalyzeConversationAuthoringProjectSettings	Ustawienia projektu.

AnalyzeConversationAuthoringProjectMetadata

Objekt

Reprezentuje metadane projektu.

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Reprezentuje datę i godzinę utworzenia projektu.
description	string	Opis projektu.
language	string	Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
lastDeployedDateTime	string (date-time)	Reprezentuje datę i godzinę ostatniego wdrożenia projektu.
lastModifiedDateTime	string (date-time)	Reprezentuje datę i godzinę utworzenia projektu.
lastTrainedDateTime	string (date-time)	Reprezentuje projekt z ostatnią wygenerowaną datą i godziną.
multilingual	boolean	Czy projekt będzie używany w wielu językach, czy nie.
projectKind	ProjectKind	Reprezentuje rodzaj projektu.
projectName	string maxLength: 100	Nowa nazwa projektu.
settings	AnalyzeConversationAuthoringProjectSettings	Ustawienia projektu.

AnalyzeConversationAuthoringProjectSettings

Objekt

Reprezentuje ustawienia używane do definiowania zachowania projektu.

Nazwa	Typ	Opis
confidenceThreshold	number (float)	Próg intencji z najwyższym poziomem ufności, przy którym przewidywanie zostanie automatycznie zmienione na "Brak". Wartość progu powinna należeć do przedziału od 0 do 1 włącznie.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

ProjectKind

Wyliczanie

Wartość	Opis
Conversation	Projekt tworzenia języka naturalnego w aplikacjach, botach i urządzeniach IoT.
Orchestration	Projekt do łączenia i organizowania konwersacji, niestandardowych odpowiedzi na pytania i projektów LUIS w jednym projekcie.